Cisco-IOS-XR-man-ipsla-cfg API API Reference
API generated from Cisco-IOS-XR-man-ipsla-cfg@2015-11-09.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
IPSLA - Update
Update operation of resource: ipsla
ipslabody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer" Probe/Control timeout in milliseconds
range: "1..604800"
units: "second"
default: "900"
}, {
"local-address": "string", IP address of the Responder {
"port": "string" Configure port number for ippmserver listening\nport
}
]
}
}
]
}
}
}, {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}, { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Specify a discovery refresh interval
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this operation
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Specify a discovery refresh interval
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Specify a discovery refresh interval
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this operation
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}, "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: "20480" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}, "disable": [ null ] states true if hw-timestamp is disabled
}
}, "inactivity-timer": "integer", Configure ippmserver inactivity timer value in\nseconds
range: "1..6000"
units: "second"
default: "900"
"port": "string" Configure port number for ippmserver listening\nport
}, {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Specify a discovery refresh interval
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Specify a discovery refresh interval
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}, "interval": "integer" Specify a discovery refresh interval
range: "30..70560"
units: "minute"
default: "300"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Create
Create operation of resource: ipsla
ipslabody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer" Probe/Control timeout in milliseconds
range: "1..604800"
units: "second"
default: "900"
}, {
"local-address": "string", IP address of the Responder {
"port": "string" Configure port number for ippmserver listening\nport
}
]
}
}
]
}
}
}, {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}, { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Specify a discovery refresh interval
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this operation
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Specify a discovery refresh interval
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Specify a discovery refresh interval
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this operation
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}, "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: "20480" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}, "disable": [ null ] states true if hw-timestamp is disabled
}
}, "inactivity-timer": "integer", Configure ippmserver inactivity timer value in\nseconds
range: "1..6000"
units: "second"
default: "900"
"port": "string" Configure port number for ippmserver listening\nport
}, {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Specify a discovery refresh interval
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Specify a discovery refresh interval
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}, "interval": "integer" Specify a discovery refresh interval
range: "30..70560"
units: "minute"
default: "300"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Delete
Delete operation of resource: ipsla
Successful operation
Internal Error
Response Content-Types: application/json
IPSLA - Retrieve
Retrieve operation of resource: ipsla
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "timeout": "integer" Probe/Control timeout in milliseconds
range: "1..604800"
units: "second"
default: "900"
}, {
"local-address": "string", IP address of the Responder {
"port": "string" Configure port number for ippmserver listening\nport
}
]
}
}
]
}
}
}, {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}, { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Specify a discovery refresh interval
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this operation
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Specify a discovery refresh interval
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Specify a discovery refresh interval
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this operation
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}, "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: "20480" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}, "disable": [ null ] states true if hw-timestamp is disabled
}
}, "inactivity-timer": "integer", Configure ippmserver inactivity timer value in\nseconds
range: "1..6000"
units: "second"
default: "900"
"port": "string" Configure port number for ippmserver listening\nport
}, {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Specify a discovery refresh interval
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Specify a discovery refresh interval
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Specify a discovery refresh interval
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}, "interval": "integer" Specify a discovery refresh interval
range: "30..70560"
units: "minute"
default: "300"
}
}
}
}
COMMON - Update
Update operation of resource: common
commonbody object
Request Content-Types: application/json
Request Example
{ "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: "20480" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}, "disable": [ null ] states true if hw-timestamp is disabled
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Create
Create operation of resource: common
commonbody object
Request Content-Types: application/json
Request Example
{ "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: "20480" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}, "disable": [ null ] states true if hw-timestamp is disabled
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Delete
Delete operation of resource: common
Successful operation
Internal Error
Response Content-Types: application/json
COMMON - Retrieve
Retrieve operation of resource: common
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: "20480" "key-chain": "string" Use MD5 authentication for IPSLA control\nmessage
}, "disable": [ null ] states true if hw-timestamp is disabled
}
}
}
HARDWARE-TIMESTAMP - Update
Update operation of resource: hardware-timestamp
hardware-timestampbody object
Successful operation
Internal Error
Response Content-Types: application/json
HARDWARE-TIMESTAMP - Create
Create operation of resource: hardware-timestamp
hardware-timestampbody object
Successful operation
Internal Error
Response Content-Types: application/json
HARDWARE-TIMESTAMP - Delete
Delete operation of resource: hardware-timestamp
Successful operation
Internal Error
Response Content-Types: application/json
HARDWARE-TIMESTAMP - Retrieve
Retrieve operation of resource: hardware-timestamp
Successful operation
Internal Error
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
Successful operation
Internal Error
MPLS-LSP-MONITOR - Update
Update operation of resource: mpls-lsp-monitor
mpls-lsp-monitorbody object
Request Content-Types: application/json
Request Example
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Create
Create operation of resource: mpls-lsp-monitor
mpls-lsp-monitorbody object
Request Content-Types: application/json
Request Example
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Delete
Delete operation of resource: mpls-lsp-monitor
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-MONITOR - Retrieve
Retrieve operation of resource: mpls-lsp-monitor
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}, {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
}
REACTIONS - Update
Update operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Create
Create operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Delete
Delete operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Retrieve
Retrieve operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
}
REACTION - Update
Update operation of resource: reaction
reactionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Create
Create operation of resource: reaction
reactionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Delete
Delete operation of resource: reaction
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Retrieve
Retrieve operation of resource: reaction
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
CONDITION - Update
Update operation of resource: condition
conditionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Create
Create operation of resource: condition
conditionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Delete
Delete operation of resource: condition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Retrieve
Retrieve operation of resource: condition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
}
LPD-TREE-TRACE - Update
Update operation of resource: lpd-tree-trace
lpd-tree-tracebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Create
Create operation of resource: lpd-tree-trace
lpd-tree-tracebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Delete
Delete operation of resource: lpd-tree-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-TREE-TRACE - Retrieve
Retrieve operation of resource: lpd-tree-trace
ID of monitor-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
TIMEOUT - Update
Update operation of resource: timeout
timeoutbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Create
Create operation of resource: timeout
timeoutbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Delete
Delete operation of resource: timeout
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Retrieve
Retrieve operation of resource: timeout
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
LPD-GROUP - Update
Update operation of resource: lpd-group
lpd-groupbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Create
Create operation of resource: lpd-group
lpd-groupbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Delete
Delete operation of resource: lpd-group
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
LPD-GROUP - Retrieve
Retrieve operation of resource: lpd-group
ID of monitor-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
CONNECTION-LOSS - Update
Update operation of resource: connection-loss
connection-lossbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Create
Create operation of resource: connection-loss
connection-lossbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Delete
Delete operation of resource: connection-loss
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Retrieve
Retrieve operation of resource: connection-loss
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of monitor-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
"count1": "integer", Probe count for consecutive
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
SCHEDULES - Update
Update operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Create
Create operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Delete
Delete operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Retrieve
Retrieve operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
}
SCHEDULE - Update
Update operation of resource: schedule
schedulebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Create
Create operation of resource: schedule
schedulebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Delete
Delete operation of resource: schedule
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Retrieve
Retrieve operation of resource: schedule
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"
"monitor-id": "integer" Monitor indentifier
range: "1..2048"
}
]
}
START-TIME - Update
Update operation of resource: start-time
start-timebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Create
Create operation of resource: start-time
start-timebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Delete
Delete operation of resource: start-time
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Retrieve
Retrieve operation of resource: start-time
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year (optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
DEFINITIONS - Update
Update operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Create
Create operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Delete
Delete operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Retrieve
Retrieve operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
}
DEFINITION - Update
Update operation of resource: definition
definitionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Create
Create operation of resource: definition
definitionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Delete
Delete operation of resource: definition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Retrieve
Retrieve operation of resource: definition
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"monitor-id": "integer" Monitor identifier
range: "1..2048"
}
]
}
OPERATION-TYPE - Update
Update operation of resource: operation-type
operation-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Create
Create operation of resource: operation-type
operation-typebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Delete
Delete operation of resource: operation-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Retrieve
Retrieve operation of resource: operation-type
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
}
MPLS-LSP-TRACE - Update
Update operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Create
Create operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Delete
Delete operation of resource: mpls-lsp-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Retrieve
Retrieve operation of resource: mpls-lsp-trace
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
REPLY - Update
Update operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
SCAN - Update
Update operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Create
Create operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Delete
Delete operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Retrieve
Retrieve operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}
}
MPLS-LSP-PING - Update
Update operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Create
Create operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Delete
Delete operation of resource: mpls-lsp-ping
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Retrieve
Retrieve operation of resource: mpls-lsp-ping
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..2"
units: "hour"
default: "2"
}, "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Time interval for automatic discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}, "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}, "request": "integer" Payload size in request probe packet
range: "100..17986"
units: "byte"
default: "100"
},
"accesslist": "string", Apply access list to filter PE addresses
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"tag": "string", Add a tag for this MPLSLM instance
"vrf": "string", Specify a VRF instance to be monitored
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "255" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of monitor-id
Successful operation
Internal Error
PATH-DISCOVER - Update
Update operation of resource: path-discover
path-discoverbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Send interval between echo requests\nduring path discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Create
Create operation of resource: path-discover
path-discoverbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Send interval between echo requests\nduring path discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Delete
Delete operation of resource: path-discover
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH-DISCOVER - Retrieve
Retrieve operation of resource: path-discover
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "1..16"
default: "1"
}, "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..900"
units: "second"
default: "120"
},
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0" "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Send interval between echo requests\nduring path discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for path discovery request
range: "1..900"
units: "second"
default: "120"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for path discovery request
range: "1..900"
units: "second"
default: "120"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"
"timeout": "integer" Timeout value for path discovery request
range: "1..900"
units: "second"
default: "120"
}
}
PATH - Update
Update operation of resource: path
pathbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of attempts before declaring the\npath as down
range: "1..16"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Create
Create operation of resource: path
pathbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of attempts before declaring the\npath as down
range: "1..16"
default: "1"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Delete
Delete operation of resource: path
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
PATH - Retrieve
Retrieve operation of resource: path
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
},
"retry": "integer" Number of attempts before declaring the\npath as down
range: "1..16"
default: "1"
}
}
SECONDARY-FREQUENCY - Update
Update operation of resource: secondary-frequency
secondary-frequencybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Create
Create operation of resource: secondary-frequency
secondary-frequencybody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Delete
Delete operation of resource: secondary-frequency
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-FREQUENCY - Retrieve
Retrieve operation of resource: secondary-frequency
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
"type": "enumeration" Condition type of path failure
Options:
connection-loss
timeout
both
}
}
ECHO - Update
Update operation of resource: echo
echobody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Send interval between echo requests\nduring path discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Create
Create operation of resource: echo
echobody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Send interval between echo requests\nduring path discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Delete
Delete operation of resource: echo
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
ECHO - Retrieve
Retrieve operation of resource: echo
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request "bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"
},
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..10"
default: "3"
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..3600"
units: "second"
default: "5"
"interval": "integer" Send interval between echo requests\nduring path discovery
range: "0..3600000"
units: "millisecond"
default: "0"
}
}
MULTIPATH - Update
Update operation of resource: multipath
multipathbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Create
Create operation of resource: multipath
multipathbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Delete
Delete operation of resource: multipath
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
MULTIPATH - Retrieve
Retrieve operation of resource: multipath
ID of monitor-id
Successful operation
Internal Error
REPLY - Update
Update operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of monitor-id
Successful operation
Internal Error
SCAN - Update
Update operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Create
Create operation of resource: scan
scanbody object
ID of monitor-id
Request Content-Types: application/json
Request Example
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Delete
Delete operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
SCAN - Retrieve
Retrieve operation of resource: scan
ID of monitor-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"
"interval": "integer" Time interval for automatic discovery
range: "1..70560"
units: "minute"
default: "240"
}
}
OPERATION - Update
Update operation of resource: operation
operationbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Create
Create operation of resource: operation
operationbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Delete
Delete operation of resource: operation
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION - Retrieve
Retrieve operation of resource: operation
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}, {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
}
SCHEDULES - Update
Update operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Create
Create operation of resource: schedules
schedulesbody object
Request Content-Types: application/json
Request Example
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Delete
Delete operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULES - Retrieve
Retrieve operation of resource: schedules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
SCHEDULE - Update
Update operation of resource: schedule
schedulebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Create
Create operation of resource: schedule
schedulebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Delete
Delete operation of resource: schedule
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
SCHEDULE - Retrieve
Retrieve operation of resource: schedule
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"
"life": "string", Length of the time to execute (default 3600\nseconds)
range: "0..2147483647" "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
},
"recurring": [ null ], probe to be scheduled automatically every day
"operation-id": "integer" Operation number
range: "1..2048"
}
}
START-TIME - Update
Update operation of resource: start-time
start-timebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Create
Create operation of resource: start-time
start-timebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Delete
Delete operation of resource: start-time
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
START-TIME - Retrieve
Retrieve operation of resource: start-time
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"
"month": "enumeration", Month of the year (optional. Default current\nmonth)
Options:
january
february
march
april
may
june
july
august
september
october
november
december
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"
"schedule-type": "enumeration", Type of schedule
Options:
pending
now
after
at
"year": "integer", Year(optional. Default current year)
range: "1993..2035"
"day": "integer", Day of the month(optional. Default today)
range: "1..31"
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"
}
}
REACTIONS - Update
Update operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Create
Create operation of resource: reactions
reactionsbody object
Request Content-Types: application/json
Request Example
{ { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Delete
Delete operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
REACTIONS - Retrieve
Retrieve operation of resource: reactions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
REACTION - Update
Update operation of resource: reaction
reactionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Create
Create operation of resource: reaction
reactionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Delete
Delete operation of resource: reaction
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION - Retrieve
Retrieve operation of resource: reaction
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
}
CONDITION - Update
Update operation of resource: condition
conditionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Create
Create operation of resource: condition
conditionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Delete
Delete operation of resource: condition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONDITION - Retrieve
Retrieve operation of resource: condition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}, "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
}
JITTER-AVERAGE-DS - Update
Update operation of resource: jitter-average-ds
jitter-average-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Create
Create operation of resource: jitter-average-ds
jitter-average-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Delete
Delete operation of resource: jitter-average-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-DS - Retrieve
Retrieve operation of resource: jitter-average-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
TIMEOUT - Update
Update operation of resource: timeout
timeoutbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Create
Create operation of resource: timeout
timeoutbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Delete
Delete operation of resource: timeout
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUT - Retrieve
Retrieve operation of resource: timeout
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
JITTER-AVERAGE - Update
Update operation of resource: jitter-average
jitter-averagebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Create
Create operation of resource: jitter-average
jitter-averagebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Delete
Delete operation of resource: jitter-average
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE - Retrieve
Retrieve operation of resource: jitter-average
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
VERIFY-ERROR - Update
Update operation of resource: verify-error
verify-errorbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Create
Create operation of resource: verify-error
verify-errorbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Delete
Delete operation of resource: verify-error
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
VERIFY-ERROR - Retrieve
Retrieve operation of resource: verify-error
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
RTT - Update
Update operation of resource: rtt
rttbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Create
Create operation of resource: rtt
rttbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Delete
Delete operation of resource: rtt
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
RTT - Retrieve
Retrieve operation of resource: rtt
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
PACKET-LOSS-SD - Update
Update operation of resource: packet-loss-sd
packet-loss-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Create
Create operation of resource: packet-loss-sd
packet-loss-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Delete
Delete operation of resource: packet-loss-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-SD - Retrieve
Retrieve operation of resource: packet-loss-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
JITTER-AVERAGE-SD - Update
Update operation of resource: jitter-average-sd
jitter-average-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Create
Create operation of resource: jitter-average-sd
jitter-average-sdbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Delete
Delete operation of resource: jitter-average-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
JITTER-AVERAGE-SD - Retrieve
Retrieve operation of resource: jitter-average-sd
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
CONNECTION-LOSS - Update
Update operation of resource: connection-loss
connection-lossbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Create
Create operation of resource: connection-loss
connection-lossbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Delete
Delete operation of resource: connection-loss
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTION-LOSS - Retrieve
Retrieve operation of resource: connection-loss
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
PACKET-LOSS-DS - Update
Update operation of resource: packet-loss-ds
packet-loss-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Create
Create operation of resource: packet-loss-ds
packet-loss-dsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Delete
Delete operation of resource: packet-loss-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET-LOSS-DS - Retrieve
Retrieve operation of resource: packet-loss-ds
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}, "upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"
}, "trigger": [ null ], Generate trigger to active reaction triggered\noperation(s)
"logging": [ null ] Generate a syslog alarm on threshold violation
}
}
}
THRESHOLD-LIMITS - Update
Update operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Create
Create operation of resource: threshold-limits
threshold-limitsbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Delete
Delete operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-LIMITS - Retrieve
Retrieve operation of resource: threshold-limits
ID of operation-id
Successful operation
Internal Error
ACTION-TYPE - Update
Update operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Create
Create operation of resource: action-type
action-typebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Delete
Delete operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ACTION-TYPE - Retrieve
Retrieve operation of resource: action-type
ID of operation-id
Successful operation
Internal Error
THRESHOLD-TYPE - Update
Update operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Create
Create operation of resource: threshold-type
threshold-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Delete
Delete operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD-TYPE - Retrieve
Retrieve operation of resource: threshold-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "thresh-type": "enumeration", Type of thresholding to perform
Options:
immediate
consecutive
xof-y
average
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"
"count2": "integer" Y value, when threshold type is XofY
}
}
REACTION-TRIGGERS - Update
Update operation of resource: reaction-triggers
reaction-triggersbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Create
Create operation of resource: reaction-triggers
reaction-triggersbody object
Request Content-Types: application/json
Request Example
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Delete
Delete operation of resource: reaction-triggers
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGERS - Retrieve
Retrieve operation of resource: reaction-triggers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
}
REACTION-TRIGGER - Update
Update operation of resource: reaction-trigger
reaction-triggerbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Create
Create operation of resource: reaction-trigger
reaction-triggerbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Delete
Delete operation of resource: reaction-trigger
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REACTION-TRIGGER - Retrieve
Retrieve operation of resource: reaction-trigger
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"
}
]
}
DEFINITIONS - Update
Update operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Create
Create operation of resource: definitions
definitionsbody object
Request Content-Types: application/json
Request Example
{ { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Delete
Delete operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITIONS - Retrieve
Retrieve operation of resource: definitions
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
]
}
}
DEFINITION - Update
Update operation of resource: definition
definitionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Create
Create operation of resource: definition
definitionbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Delete
Delete operation of resource: definition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DEFINITION - Retrieve
Retrieve operation of resource: definition
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
},
"operation-id": "integer" Operation number
range: "1..2048"
}
}
OPERATION-TYPE - Update
Update operation of resource: operation-type
operation-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Create
Create operation of resource: operation-type
operation-typebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Delete
Delete operation of resource: operation-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
OPERATION-TYPE - Retrieve
Retrieve operation of resource: operation-type
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}, "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Interval in seconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in history\nbuffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
}
ICMP-ECHO - Update
Update operation of resource: icmp-echo
icmp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Create
Create operation of resource: icmp-echo
icmp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Delete
Delete operation of resource: icmp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-ECHO - Retrieve
Retrieve operation of resource: icmp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"dest-address": "string", Enter IPv4 address of the destination device
"source-address-v6": "string", Enter IPv6 address of the source device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
MPLS-LSP-PING - Update
Update operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Create
Create operation of resource: mpls-lsp-ping
mpls-lsp-pingbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Delete
Delete operation of resource: mpls-lsp-ping
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-PING - Retrieve
Retrieve operation of resource: mpls-lsp-ping
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}, "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
},
"source-address": "string", Enter IPv4 address of the source device {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "request": "integer" Payload size in request probe packet
range: "100..17986"
default: "100"
},
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60" "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"ttl": "integer", Time to live value
range: "1..255"
default: "255"
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0" "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
REPLY - Update
Update operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
control-channel
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vc-id": "integer", Virtual circuit ID
range: "1..4294967295"
"address": "string" IP address for target
}
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}, "tunnel": "integer" Tunnel interface number
range: "0..65535"
}
}
}
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
FEC-ADDRESS - Update
Update operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Create
Create operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Delete
Delete operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Retrieve
Retrieve operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
PSEUDOWIRE - Update
Update operation of resource: pseudowire
pseudowirebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Create
Create operation of resource: pseudowire
pseudowirebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Delete
Delete operation of resource: pseudowire
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE - Retrieve
Retrieve operation of resource: pseudowire
ID of operation-id
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
UDP-ECHO - Update
Update operation of resource: udp-echo
udp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Create
Create operation of resource: udp-echo
udp-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Delete
Delete operation of resource: udp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-ECHO - Retrieve
Retrieve operation of resource: udp-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "request": "integer" Payload size in request probe packet
range: "16..1500"
units: "byte"
default: "16"
}, "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Specify number of history buckets
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
},
"tag": "string", Add a tag for this operation
"dest-port": "string", Port number on target device
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
MPLS-LSP-TRACE - Update
Update operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Create
Create operation of resource: mpls-lsp-trace
mpls-lsp-tracebody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Delete
Delete operation of resource: mpls-lsp-trace
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LSP-TRACE - Retrieve
Retrieve operation of resource: mpls-lsp-trace
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"source-address": "string", Enter IPv4 address of the source device
"tag": "string", Add a tag for this operation "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
},
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
"output-interface": "string", Echo request output interface
"output-nexthop": "string", Echo request output nexthop
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"ttl": "integer", Time to live value
range: "1..255"
default: "30" "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}, "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
},
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing
"force-explicit-null ]: [ null ] Forced option for the MPLS LSP operation
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "tunnel": "integer" Tunnel interface number
range: "0..65535"
}, "mask": "string", IP netmask for target
"address": "string" IP address for target
}
}
}
}
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of operation-id
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
ID of operation-id
Successful operation
Internal Error
FEC-ADDRESS - Update
Update operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Create
Create operation of resource: fec-address
fec-addressbody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Delete
Delete operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
FEC-ADDRESS - Retrieve
Retrieve operation of resource: fec-address
ID of operation-id
Successful operation
Internal Error
REPLY - Update
Update operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Create
Create operation of resource: reply
replybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Delete
Delete operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
REPLY - Retrieve
Retrieve operation of resource: reply
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mode": "enumeration", Enables use of router alert in echo reply\npackets
Options:
ipv4-udp-router-alert
"dscp-bits": "string" DSCP bits in the reply IP header
range: "0..63"
}
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration" Choose type of data to be stored in history\nbuffer
Options:
failed
all
}
}
UDP-JITTER - Update
Update operation of resource: udp-jitter
udp-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Packet interval in milliseconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Create
Create operation of resource: udp-jitter
udp-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Packet interval in milliseconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Delete
Delete operation of resource: udp-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
UDP-JITTER - Retrieve
Retrieve operation of resource: udp-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"verify-data": [ null ], Check each IPSLA response for corruption
"source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0" {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Packet interval in milliseconds
range: "1..3600"
units: "second"
}
]
}, "request": "integer" Payload size in request probe packet
range: "28..1500"
units: "byte"
default: "32"
},
"tag": "string", Add a tag for this operation "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
},
"control-disable": [ null ], Disable control packets
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000"
"source-port": "string", Port number on source device
"dest-address": "string", Enter IPv4 address of the destination device
"dest-port": "string" Port number on target device
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
PACKET - Update
Update operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Create
Create operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Delete
Delete operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Retrieve
Retrieve operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..60000"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}
}
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
ENHANCED-STATS - Update
Update operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Create
Create operation of resource: enhanced-stats
enhanced-statsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Delete
Delete operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STATS - Retrieve
Retrieve operation of resource: enhanced-stats
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..100"
default: "15"
"interval": "integer" Interval in seconds
range: "1..3600"
units: "second"
}
]
}
}
ENHANCED-STAT - Update
Update operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Create
Create operation of resource: enhanced-stat
enhanced-statbody object
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Delete
Delete operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
Response Content-Types: application/json
ENHANCED-STAT - Retrieve
Retrieve operation of resource: enhanced-stat
ID of operation-id
ID of interval
Successful operation
Internal Error
ICMP-PATH-ECHO - Update
Update operation of resource: icmp-path-echo
icmp-path-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in\nhistory buffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Create
Create operation of resource: icmp-path-echo
icmp-path-echobody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in\nhistory buffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Delete
Delete operation of resource: icmp-path-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-ECHO - Retrieve
Retrieve operation of resource: icmp-path-echo
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in\nhistory buffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}, "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"source-address": "string", Enter IPv4 address of the source device "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
},
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
HISTORY - Update
Update operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in\nhistory buffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Create
Create operation of resource: history
historybody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in\nhistory buffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Delete
Delete operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
HISTORY - Retrieve
Retrieve operation of resource: history
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"
"history-filter": "enumeration", Choose type of data to be stored in\nhistory buffer
Options:
failed
all
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
STATISTICS - Update
Update operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Create
Create operation of resource: statistics
statisticsbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Delete
Delete operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"
}
}
LSR-PATH - Update
Update operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Create
Create operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Delete
Delete operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Retrieve
Retrieve operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
ICMP-PATH-JITTER - Update
Update operation of resource: icmp-path-jitter
icmp-path-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Create
Create operation of resource: icmp-path-jitter
icmp-path-jitterbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Delete
Delete operation of resource: icmp-path-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
ICMP-PATH-JITTER - Retrieve
Retrieve operation of resource: icmp-path-jitter
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "source-address": "string", Enter IPv4 address of the source device
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"
"tag": "string", Add a tag for this operation "request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "36"
},
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..604800000"
units: "millisecond"
default: "5000" "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}, "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
},
"dest-address": "string" Enter IPv4 address of the destination device
}
}
DATA-SIZE - Update
Update operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Create
Create operation of resource: data-size
data-sizebody object
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Delete
Delete operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
DATA-SIZE - Retrieve
Retrieve operation of resource: data-size
ID of operation-id
Successful operation
Internal Error
PACKET - Update
Update operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Create
Create operation of resource: packet
packetbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Delete
Delete operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
PACKET - Retrieve
Retrieve operation of resource: packet
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"
"interval": "integer" Packet interval in milliseconds
range: "1..60000"
units: "millisecond"
default: "20"
}
}
LSR-PATH - Update
Update operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Create
Create operation of resource: lsr-path
lsr-pathbody object
ID of operation-id
Request Content-Types: application/json
Request Example
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Delete
Delete operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-PATH - Retrieve
Retrieve operation of resource: lsr-path
ID of operation-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "node8": "string", IPv4 address of the intermediate node
"node1": "string", IPv4 address of the intermediate node
"node3": "string", IPv4 address of the intermediate node
"node2": "string", IPv4 address of the intermediate node
"node5": "string", IPv4 address of the intermediate node
"node4": "string", IPv4 address of the intermediate node
"node7": "string", IPv4 address of the intermediate node
"node6": "string" IPv4 address of the intermediate node
}
}
RESPONDER - Update
Update operation of resource: responder
responderbody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer" Configure responder timeout value in seconds
range: "1..604800"
units: "second"
default: "900"
}, {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}, {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Create
Create operation of resource: responder
responderbody object
Request Content-Types: application/json
Request Example
{ "timeout": "integer" Configure responder timeout value in seconds
range: "1..604800"
units: "second"
default: "900"
}, {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}, {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Delete
Delete operation of resource: responder
Successful operation
Internal Error
Response Content-Types: application/json
RESPONDER - Retrieve
Retrieve operation of resource: responder
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "timeout": "integer" Configure responder timeout value in seconds
range: "1..604800"
units: "second"
default: "900"
}, {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}, {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}
}
TWAMP - Update
Update operation of resource: twamp
twampbody object
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP - Create
Create operation of resource: twamp
twampbody object
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP - Delete
Delete operation of resource: twamp
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP - Retrieve
Retrieve operation of resource: twamp
Successful operation
Internal Error
TYPE - Update
Update operation of resource: type
typebody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Create
Create operation of resource: type
typebody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Delete
Delete operation of resource: type
Successful operation
Internal Error
Response Content-Types: application/json
TYPE - Retrieve
Retrieve operation of resource: type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
}
UDP - Update
Update operation of resource: udp
udpbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Create
Create operation of resource: udp
udpbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Delete
Delete operation of resource: udp
Successful operation
Internal Error
Response Content-Types: application/json
UDP - Retrieve
Retrieve operation of resource: udp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
}
ADDRESSES - Update
Update operation of resource: addresses
addressesbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Create
Create operation of resource: addresses
addressesbody object
Request Content-Types: application/json
Request Example
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Delete
Delete operation of resource: addresses
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Retrieve
Retrieve operation of resource: addresses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"local-address": "string", IP address of the Responder {
"port": "string" Port number to be enabled
}
]
}
}
]
}
}
ADDRESS - Update
Update operation of resource: address
addressbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Create
Create operation of resource: address
addressbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Delete
Delete operation of resource: address
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Retrieve
Retrieve operation of resource: address
ID of local-address
Successful operation
Internal Error
PORTS - Update
Update operation of resource: ports
portsbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Create
Create operation of resource: ports
portsbody object
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Delete
Delete operation of resource: ports
ID of local-address
Successful operation
Internal Error
Response Content-Types: application/json
PORTS - Retrieve
Retrieve operation of resource: ports
ID of local-address
PORT - Update
Update operation of resource: port
portbody object
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Create
Create operation of resource: port
portbody object
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Delete
Delete operation of resource: port
ID of local-address
ID of port
Successful operation
Internal Error
Response Content-Types: application/json
PORT - Retrieve
Retrieve operation of resource: port
ID of local-address
ID of port
Successful operation
Internal Error
TWAMP-LIGHT - Update
Update operation of resource: twamp-light
twamp-lightbody object
Request Content-Types: application/json
Request Example
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP-LIGHT - Create
Create operation of resource: twamp-light
twamp-lightbody object
Request Content-Types: application/json
Request Example
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP-LIGHT - Delete
Delete operation of resource: twamp-light
Successful operation
Internal Error
Response Content-Types: application/json
TWAMP-LIGHT - Retrieve
Retrieve operation of resource: twamp-light
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
}
SESSION-IDS - Update
Update operation of resource: session-ids
session-idsbody object
Request Content-Types: application/json
Request Example
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION-IDS - Create
Create operation of resource: session-ids
session-idsbody object
Request Content-Types: application/json
Request Example
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION-IDS - Delete
Delete operation of resource: session-ids
Successful operation
Internal Error
Response Content-Types: application/json
SESSION-IDS - Retrieve
Retrieve operation of resource: session-ids
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
}
SESSION-ID - Update
Update operation of resource: session-id
session-idbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION-ID - Create
Create operation of resource: session-id
session-idbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION-ID - Delete
Delete operation of resource: session-id
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
SESSION-ID - Retrieve
Retrieve operation of resource: session-id
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"session-id": "integer", SessionID
range: "1..5" { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
},
"twamp-light-timeout": "integer" Configure session timeout
range: "60..86400"
units: "second"
}
]
}
LOCAL-IP - Update
Update operation of resource: local-ip
local-ipbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IP - Create
Create operation of resource: local-ip
local-ipbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IP - Delete
Delete operation of resource: local-ip
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IP - Retrieve
Retrieve operation of resource: local-ip
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}, { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
}
}
LOCAL-IPV6-ADDRESSES - Update
Update operation of resource: local-ipv6-addresses
local-ipv6-addressesbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV6-ADDRESSES - Create
Create operation of resource: local-ipv6-addresses
local-ipv6-addressesbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV6-ADDRESSES - Delete
Delete operation of resource: local-ipv6-addresses
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: local-ipv6-addresses
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
]
}
}
LOCAL-IPV6-ADDRESS - Update
Update operation of resource: local-ipv6-address
local-ipv6-addressbody object
ID of session-id
ID of localv6-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV6-ADDRESS - Create
Create operation of resource: local-ipv6-address
local-ipv6-addressbody object
ID of session-id
ID of localv6-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV6-ADDRESS - Delete
Delete operation of resource: local-ipv6-address
ID of session-id
ID of localv6-address
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: local-ipv6-address
ID of session-id
ID of localv6-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv6-address": "string" Local IPv6 address
}
}
LOCAL-PORT-NUMBERS - Update
Update operation of resource: local-port-numbers
local-port-numbersbody object
ID of session-id
ID of localv6-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBERS - Create
Create operation of resource: local-port-numbers
local-port-numbersbody object
ID of session-id
ID of localv6-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBERS - Delete
Delete operation of resource: local-port-numbers
ID of session-id
ID of localv6-address
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBERS - Retrieve
Retrieve operation of resource: local-port-numbers
ID of session-id
ID of localv6-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
}
LOCAL-PORT-NUMBER - Update
Update operation of resource: local-port-number
local-port-numberbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBER - Create
Create operation of resource: local-port-number
local-port-numberbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBER - Delete
Delete operation of resource: local-port-number
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBER - Retrieve
Retrieve operation of resource: local-port-number
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
REMOTE-IP - Update
Update operation of resource: remote-ip
remote-ipbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IP - Create
Create operation of resource: remote-ip
remote-ipbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IP - Delete
Delete operation of resource: remote-ip
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IP - Retrieve
Retrieve operation of resource: remote-ip
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
}
REMOTE-IPV4-ADDRESSES - Update
Update operation of resource: remote-ipv4-addresses
remote-ipv4-addressesbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESSES - Create
Create operation of resource: remote-ipv4-addresses
remote-ipv4-addressesbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESSES - Delete
Delete operation of resource: remote-ipv4-addresses
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: remote-ipv4-addresses
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
REMOTE-IPV4-ADDRESS - Update
Update operation of resource: remote-ipv4-address
remote-ipv4-addressbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESS - Create
Create operation of resource: remote-ipv4-address
remote-ipv4-addressbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESS - Delete
Delete operation of resource: remote-ipv4-address
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: remote-ipv4-address
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
}
REMOTE-PORT-NUMBERS - Update
Update operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Create
Create operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Delete
Delete operation of resource: remote-port-numbers
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Retrieve
Retrieve operation of resource: remote-port-numbers
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
}
}
REMOTE-PORT-NUMBER - Update
Update operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Create
Create operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Delete
Delete operation of resource: remote-port-number
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Retrieve
Retrieve operation of resource: remote-port-number
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
REMOTE-IPV6-ADDRESSES - Update
Update operation of resource: remote-ipv6-addresses
remote-ipv6-addressesbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESSES - Create
Create operation of resource: remote-ipv6-addresses
remote-ipv6-addressesbody object
ID of session-id
ID of localv6-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESSES - Delete
Delete operation of resource: remote-ipv6-addresses
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: remote-ipv6-addresses
ID of session-id
ID of localv6-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}
}
REMOTE-IPV6-ADDRESS - Update
Update operation of resource: remote-ipv6-address
remote-ipv6-addressbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESS - Create
Create operation of resource: remote-ipv6-address
remote-ipv6-addressbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESS - Delete
Delete operation of resource: remote-ipv6-address
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: remote-ipv6-address
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
}
REMOTE-PORT-NUMBERS - Update
Update operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Create
Create operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Delete
Delete operation of resource: remote-port-numbers
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Retrieve
Retrieve operation of resource: remote-port-numbers
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
}
}
REMOTE-PORT-NUMBER - Update
Update operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Create
Create operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Delete
Delete operation of resource: remote-port-number
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Retrieve
Retrieve operation of resource: remote-port-number
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of session-id
ID of localv6-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
LOCAL-IPV4-ADDRESSES - Update
Update operation of resource: local-ipv4-addresses
local-ipv4-addressesbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV4-ADDRESSES - Create
Create operation of resource: local-ipv4-addresses
local-ipv4-addressesbody object
ID of session-id
Request Content-Types: application/json
Request Example
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV4-ADDRESSES - Delete
Delete operation of resource: local-ipv4-addresses
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: local-ipv4-addresses
ID of session-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
]
}
}
LOCAL-IPV4-ADDRESS - Update
Update operation of resource: local-ipv4-address
local-ipv4-addressbody object
ID of session-id
ID of localv4-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV4-ADDRESS - Create
Create operation of resource: local-ipv4-address
local-ipv4-addressbody object
ID of session-id
ID of localv4-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV4-ADDRESS - Delete
Delete operation of resource: local-ipv4-address
ID of session-id
ID of localv4-address
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: local-ipv4-address
ID of session-id
ID of localv4-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
},
"localv4-address": "string" Local IPv4 address
}
}
LOCAL-PORT-NUMBERS - Update
Update operation of resource: local-port-numbers
local-port-numbersbody object
ID of session-id
ID of localv4-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBERS - Create
Create operation of resource: local-port-numbers
local-port-numbersbody object
ID of session-id
ID of localv4-address
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBERS - Delete
Delete operation of resource: local-port-numbers
ID of session-id
ID of localv4-address
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBERS - Retrieve
Retrieve operation of resource: local-port-numbers
ID of session-id
ID of localv4-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
}
LOCAL-PORT-NUMBER - Update
Update operation of resource: local-port-number
local-port-numberbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBER - Create
Create operation of resource: local-port-number
local-port-numberbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBER - Delete
Delete operation of resource: local-port-number
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-PORT-NUMBER - Retrieve
Retrieve operation of resource: local-port-number
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
},
"local-port": "string" Local port
}
]
}
REMOTE-IP - Update
Update operation of resource: remote-ip
remote-ipbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IP - Create
Create operation of resource: remote-ip
remote-ipbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IP - Delete
Delete operation of resource: remote-ip
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IP - Retrieve
Retrieve operation of resource: remote-ip
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}, { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
}
REMOTE-IPV4-ADDRESSES - Update
Update operation of resource: remote-ipv4-addresses
remote-ipv4-addressesbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESSES - Create
Create operation of resource: remote-ipv4-addresses
remote-ipv4-addressesbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESSES - Delete
Delete operation of resource: remote-ipv4-addresses
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESSES - Retrieve
Retrieve operation of resource: remote-ipv4-addresses
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
]
}
}
REMOTE-IPV4-ADDRESS - Update
Update operation of resource: remote-ipv4-address
remote-ipv4-addressbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESS - Create
Create operation of resource: remote-ipv4-address
remote-ipv4-addressbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESS - Delete
Delete operation of resource: remote-ipv4-address
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV4-ADDRESS - Retrieve
Retrieve operation of resource: remote-ipv4-address
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev4-address": "string" Remote IPv4 address
}
}
REMOTE-PORT-NUMBERS - Update
Update operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Create
Create operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Delete
Delete operation of resource: remote-port-numbers
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Retrieve
Retrieve operation of resource: remote-port-numbers
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
}
}
REMOTE-PORT-NUMBER - Update
Update operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Create
Create operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Delete
Delete operation of resource: remote-port-number
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Retrieve
Retrieve operation of resource: remote-port-number
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev4-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
REMOTE-IPV6-ADDRESSES - Update
Update operation of resource: remote-ipv6-addresses
remote-ipv6-addressesbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESSES - Create
Create operation of resource: remote-ipv6-addresses
remote-ipv6-addressesbody object
ID of session-id
ID of localv4-address
ID of local-port
Request Content-Types: application/json
Request Example
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESSES - Delete
Delete operation of resource: remote-ipv6-addresses
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESSES - Retrieve
Retrieve operation of resource: remote-ipv6-addresses
ID of session-id
ID of localv4-address
ID of local-port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
]
}
}
REMOTE-IPV6-ADDRESS - Update
Update operation of resource: remote-ipv6-address
remote-ipv6-addressbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESS - Create
Create operation of resource: remote-ipv6-address
remote-ipv6-addressbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Request Content-Types: application/json
Request Example
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESS - Delete
Delete operation of resource: remote-ipv6-address
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-IPV6-ADDRESS - Retrieve
Retrieve operation of resource: remote-ipv6-address
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
},
"remotev6-address": "string" Remote IPv6 address
}
}
REMOTE-PORT-NUMBERS - Update
Update operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Create
Create operation of resource: remote-port-numbers
remote-port-numbersbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Delete
Delete operation of resource: remote-port-numbers
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBERS - Retrieve
Retrieve operation of resource: remote-port-numbers
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"vrf-name": "string" VRF Name
}
]
},
"remote-port": "string" Remote port
}
]
}
}
REMOTE-PORT-NUMBER - Update
Update operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Create
Create operation of resource: remote-port-number
remote-port-numberbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Delete
Delete operation of resource: remote-port-number
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-PORT-NUMBER - Retrieve
Retrieve operation of resource: remote-port-number
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of session-id
ID of localv4-address
ID of local-port
ID of remotev6-address
ID of remote-port
ID of vrf-name
Successful operation
Internal Error
MPLS-DISCOVERY - Update
Update operation of resource: mpls-discovery
mpls-discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Create
Create operation of resource: mpls-discovery
mpls-discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Delete
Delete operation of resource: mpls-discovery
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-DISCOVERY - Retrieve
Retrieve operation of resource: mpls-discovery
Successful operation
Internal Error
VPN - Update
Update operation of resource: vpn
vpnbody object
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Create
Create operation of resource: vpn
vpnbody object
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Delete
Delete operation of resource: vpn
Successful operation
Internal Error
Response Content-Types: application/json
VPN - Retrieve
Retrieve operation of resource: vpn
Successful operation
Internal Error
SERVER-TWAMP - Update
Update operation of resource: server-twamp
server-twampbody object
Request Content-Types: application/json
Request Example
{ "inactivity-timer": "integer", Configure ippmserver inactivity timer value in\nseconds
range: "1..6000"
units: "second"
default: "900"
"port": "string" Configure port number for ippmserver listening\nport
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-TWAMP - Create
Create operation of resource: server-twamp
server-twampbody object
Request Content-Types: application/json
Request Example
{ "inactivity-timer": "integer", Configure ippmserver inactivity timer value in\nseconds
range: "1..6000"
units: "second"
default: "900"
"port": "string" Configure port number for ippmserver listening\nport
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-TWAMP - Delete
Delete operation of resource: server-twamp
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-TWAMP - Retrieve
Retrieve operation of resource: server-twamp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "inactivity-timer": "integer", Configure ippmserver inactivity timer value in\nseconds
range: "1..6000"
units: "second"
default: "900"
"port": "string" Configure port number for ippmserver listening\nport
}
}